com.highdeal.hci

Class NumberModel

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.hci.NumberModel

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class NumberModel
extends HCIModelAdapter

This class is a BigDecimal container.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="number">
  <xs:complexType>
    <xs:attribute name="value" type="xs:decimal"/>
  </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The XML tag name of the NumberModel

Constructor Summary

Constructors

Constructor and Description
NumberModel() Constructs a NumberModel with a null BigDecimal.
NumberModel(BigDecimal value) Constructs a NumberModel with a given BigDecimal.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getTagName() Gets the XML tag name of the HCI model.
BigDecimal	getValue() Gets the number contained by the NumberModel.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setValue(BigDecimal value) Sets the number contained by the NumberModel.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

The XML tag name of the NumberModel

See Also:

Constant Field Values

Constructor Detail

NumberModel

public NumberModel()

Constructs a NumberModel with a null BigDecimal.

NumberModel

public NumberModel(BigDecimal value)

Constructs a NumberModel with a given BigDecimal.

Parameters:

value - the number of the NumberModel.

Method Detail

getValue

public BigDecimal getValue()

Gets the number contained by the NumberModel.

Returns:

The number contained by the NumberModel

setValue

public void setValue(BigDecimal value)

Sets the number contained by the NumberModel.

Parameters:

value - The number contained by the NumberModel

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into

getTagName

public String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name